1   /* Copyright 2002-2016 CS Systèmes d'Information
2    * Licensed to CS Systèmes d'Information (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.orekit.forces.drag;
18  
19  import java.io.Serializable;
20  
21  import org.orekit.errors.OrekitException;
22  import org.orekit.time.AbsoluteDate;
23  
24  
25  /** Container for solar activity data, compatible with DTM2000 Atmosphere model.
26   *
27   * This model needs mean and instantaneous solar flux and geomagnetic incides to
28   * compute the local density. Mean solar flux is (for the moment) represented by
29   * the F10.7 indices. Instantaneous flux can be set to the mean value if the
30   * data is not available. Geomagnetic acivity is represented by the Kp indice,
31   * which goes from 1 (very low activity) to 9 (high activity).
32   * <p>
33   * All needed solar activity data can be found on the <a
34   * href="http://sec.noaa.gov/Data/index.html">
35   * NOAA (National Oceanic and Atmospheric
36   * Administration) website.</a>
37   *</p>
38   *
39   * @author Fabien Maussion
40   */
41  public interface DTM2000InputParameters extends Serializable {
42  
43      /** Gets the available data range minimum date.
44       * @return the minimum date.
45       * @exception OrekitException if data cannot be loaded
46       */
47      AbsoluteDate getMinDate() throws OrekitException;
48  
49      /** Gets the available data range maximum date.
50       * @return the maximum date.
51       * @exception OrekitException if data cannot be loaded
52       */
53      AbsoluteDate getMaxDate() throws OrekitException;
54  
55      /** Get the value of the instantaneous solar flux.
56       * @param date the current date
57       * @return the instantaneous solar flux
58       * @exception OrekitException if the date is out of range of available data
59       */
60      double getInstantFlux(AbsoluteDate date) throws OrekitException;
61  
62      /** Get the value of the mean solar flux.
63       * @param date the current date
64       * @return the mean solar flux
65       * @exception OrekitException if the date is out of range of available data
66       */
67      double getMeanFlux(AbsoluteDate date) throws OrekitException;
68  
69      /** Get the value of the 3 hours geomagnetic index.
70       * With a delay of 3 hours at pole to 6 hours at equator using:
71       * delay=6-abs(lat)*0.033 (lat in deg.)
72       * @param date the current date
73       * @return the 3H geomagnetic index
74       * @exception OrekitException if the date is out of range of available data
75       */
76      double getThreeHourlyKP(AbsoluteDate date) throws OrekitException;
77  
78      /** Get the last 24H mean geomagnetic index.
79       * @param date the current date
80       * @return the 24H geomagnetic index
81       * @exception OrekitException if the date is out of range of available data
82       */
83      double get24HoursKp(AbsoluteDate date) throws OrekitException;
84  
85  }